Content Library PublishInfo
The Content Library PublishInfo schema defines how a local library is published publicly for synchronization to other libraries.
{
"authentication_method": "string",
"published": false,
"publish_url": "string",
"user_name": "string",
"password": "string",
"current_password": "string",
"persist_json_enabled": false
}Indicates how a subscribed library should authenticate (AuthenticationMethod) to the published library endpoint.
For more information see: Content Library PublishInfo AuthenticationMethod.
This property is required for the POST /content/local-library operation. It is optional for the PATCH /content/local-library/{libraryId} operation, and if missing or null the value will not be changed. When the existing authentication method is Content Library PublishInfo AuthenticationMethod.BASIC and authentication is being turned off by updating this property to Content Library PublishInfo AuthenticationMethod.NONE, then the Content Library PublishInfo.current_password property is required. This property will always be present in the results of the GET /content/local-library/{libraryId} operation.
Whether the local library is published.
This property is required for the POST /content/local-library operation. It is optional for the PATCH /content/local-library/{libraryId} operation, and if missing or null the value will not be changed. When the existing authentication method is Content Library PublishInfo AuthenticationMethod.BASIC and the local library is published, the Content Library PublishInfo.current_password property is required before turning off publishing. This property will always be present in the results of the GET /content/local-library/{libraryId} operation.
The URL to which the library metadata is published by the Content Library Service.
This value can be used to set the Content Library SubscriptionInfo.subscription_url property when creating a subscribed library.
This property is not used for the create operation. It will always be present in the response of the get or list operations. It is not used for the update operation.
The username to require for authentication.
This property is optional for the POST /content/local-library and PATCH /content/local-library/{libraryId} operations. When the authentication method is Content Library PublishInfo AuthenticationMethod.NONE, the username can be left missing or null. When the authentication method is Content Library PublishInfo AuthenticationMethod.BASIC, the username is ignored in the current release. It defaults to "vcsp". It is preferable to leave this missing or null. If specified, it must be set to "vcsp".
The new password to require for authentication.
This property is optional for the POST /content/local-library operation. When the authentication method is Content Library PublishInfo AuthenticationMethod.NONE, the password can be left missing or null. When the authentication method is Content Library PublishInfo AuthenticationMethod.BASIC, the password should be a non-empty string. This property is optional for the PATCH /content/local-library/{libraryId} operation. Leaving it missing or null during update indicates that the password is not changed. When the password is changed, the Content Library PublishInfo.current_password property is required. This property is not used for the GET /content/local-library/{libraryId} operation.
The current password to verify. This property is available starting in vSphere 6.7.
This property is unused for the POST /content/local-library operation. This property is optional for the PATCH /content/local-library/{libraryId} operation. When the existing authentication method is Content Library PublishInfo AuthenticationMethod.NONE, the current password can be left missing or null. When the existing authentication method is Content Library PublishInfo AuthenticationMethod.BASIC, the current password is verified before applying the new Content Library PublishInfo.password, turning off authentication, or unpublishing the library. This property is not used for the GET /content/local-library/{libraryId} operation.
Whether library and library item metadata are persisted in the storage backing as JSON files. This flag only applies if the local library is published.
Enabling JSON persistence allows you to synchronize a subscribed library manually instead of over HTTP. You copy the local library content and metadata to another storage backing manually and then create a subscribed library referencing the location of the library JSON file in the Content Library SubscriptionInfo.subscription_url. When the subscribed library's storage backing matches the subscription URL, files do not need to be copied to the subscribed library.
For a library backed by a datastore, the library JSON file will be stored at the path contentlib-{library_id}/lib.json on the datastore.
For a library backed by a remote file system, the library JSON file will be stored at {library_id}/lib.json in the remote file system path.
This property is optional for the create operation. It will always be present in the response of the get or list operations. It is optional for the update operation.